Skip to content

Update ModelArray roxygen#118

Merged
mattcieslak merged 25 commits intomainfrom
fix/update-roxygen-comments
Apr 1, 2026
Merged

Update ModelArray roxygen#118
mattcieslak merged 25 commits intomainfrom
fix/update-roxygen-comments

Conversation

@araikes
Copy link
Copy Markdown
Collaborator

@araikes araikes commented Mar 26, 2026

Some of the roxygen comments don't render correctly so this should hopefully fix this.

araikes added 3 commits March 26, 2026 12:08
This should fix the duplicate documentation of "usage" in ModelArray by separating the class and function roxygen.
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 27, 2026

Codecov Report

❌ Patch coverage is 87.75510% with 12 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.34%. Comparing base (1de8eed) to head (b3c7a3c).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
R/ModelArray_S4Methods.R 86.25% 11 Missing ⚠️
R/ModelArray_Constructor.R 92.85% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #118      +/-   ##
==========================================
- Coverage   89.51%   89.34%   -0.18%     
==========================================
  Files           6        6              
  Lines        1717     1989     +272     
==========================================
+ Hits         1537     1777     +240     
- Misses        180      212      +32     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

R/merge.R Outdated
#' head(merged$phenotypes)
#'
#' results <- ModelArray.lm(
#' FD ~ age + sex,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#' FD ~ age + sex,
#' FD ~ age + FC + sex,

R/merge.R Outdated
#' FD ~ age + sex,
#' data = merged$data,
#' phenotypes = merged$phenotypes,
#' scalar = "FD"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be scalar = c("FD", "FC")?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Probably makes more sense.

Copy link
Copy Markdown
Contributor

@mattcieslak mattcieslak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a HUGE improvement! Just a few minor comments

@mattcieslak mattcieslak merged commit 24de4cb into main Apr 1, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants